<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>Pod::LaTeX - Convert Pod data to formatted Latex - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Pod-LaTeX - MetaCPAN" href="https://metacpan.org/dist/Pod-LaTeX/releases.rss" />
        <link rel="canonical" href="./Pod::LaTeX.html" />
        <meta name="description" content="Convert Pod data to formatted Latex" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/Pod::LaTeX" />
<meta name="twitter:title"       content="Pod::LaTeX" />
<meta name="twitter:description" content="Convert Pod data to formatted Latex" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./Pod::LaTeX.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Pod-LaTeX was released.">
      <span class="relatize">18 Jan 2013 13:35:42 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/Pod-LaTeX">Pod-LaTeX</a>
  </li>
  <li>
    Module version: 0.61
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/Pod-LaTeX/source/lib/Pod/LaTeX.pm">Source</a>
    (<a href="https://metacpan.org/dist/Pod-LaTeX/source/lib/Pod/LaTeX.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/Pod-LaTeX/source/lib/Pod">Browse</a>
    (<a href="https://metacpan.org/dist/Pod-LaTeX/source/lib/Pod?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/Pod-LaTeX/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="http://github.com/timj/perl-Pod-LaTeX/tree/master">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/Pod-LaTeX/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/timj/perl-Pod-LaTeX">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-LaTeX">Issues</a>
      (4)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Pod-LaTeX+0.61" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-LaTeX.html?oncpan=1&amp;distmat=1&amp;version=0.61&amp;grade=2" style="color: #090">29</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-LaTeX.html?oncpan=1&amp;distmat=1&amp;version=0.61&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/P/Pod-LaTeX.html?oncpan=1&amp;distmat=1&amp;version=0.61&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/TJENNESS/Pod-LaTeX-0.61">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Pod-LaTeX who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 0
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/Pod-LaTeX-0.61/index.html">75.93% Coverage </a>
    </li>
    <li>
      License: perl_5
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/Pod-LaTeX/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/T/TJ/TJENNESS/Pod-LaTeX-0.61.tar.gz">
      Download (<span itemprop="fileSize">31.85KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FTJENNESS%2FPod-LaTeX-0.61%2Flib%2FPod%2FLaTeX.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-LaTeX/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/Pod-LaTeX/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:Pod-LaTeX">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="Pod-LaTeX">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/LaTeX.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="TJENNESS/Pod-LaTeX-0.61"
>0.61
  (TJENNESS on 2013-01-18)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.60"
>0.60
  (TJENNESS on 2011-11-23)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.59"
>0.59
  (TJENNESS on 2011-01-04)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.58"
>0.58
  (TJENNESS on 2004-12-30)</option>
<optgroup label="BackPAN">'
<option
  
  value="TJENNESS/Pod-LaTeX-0.57"
>0.57
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.56"
>0.56
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.55"
>0.55
  (TJENNESS on 2003-04-05)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.54"
>0.54
  (TJENNESS on 2001-11-20)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.53"
>0.53
  (TJENNESS on 2000-09-22)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.52"
>0.52
  (TJENNESS on 2000-05-16)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.51"
>0.51
  (TJENNESS on 2000-05-09)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.50"
>0.50
  (TJENNESS on 2000-03-31)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/TJENNESS/Pod-LaTeX-0.61/diff/' + encodeURIComponent(this.value) + '/lib/Pod/LaTeX.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="TJENNESS/Pod-LaTeX-0.61"
>0.61
  (TJENNESS on 2013-01-18)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.60"
>0.60
  (TJENNESS on 2011-11-23)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.59"
>0.59
  (TJENNESS on 2011-01-04)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.58"
>0.58
  (TJENNESS on 2004-12-30)</option>
<optgroup label="BackPAN">'
<option
  
  value="TJENNESS/Pod-LaTeX-0.57"
>0.57
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.56"
>0.56
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.55"
>0.55
  (TJENNESS on 2003-04-05)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.54"
>0.54
  (TJENNESS on 2001-11-20)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.53"
>0.53
  (TJENNESS on 2000-09-22)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.52"
>0.52
  (TJENNESS on 2000-05-16)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.51"
>0.51
  (TJENNESS on 2000-05-09)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.50"
>0.50
  (TJENNESS on 2000-03-31)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><a href="./Pod::Find.html" title="Pod::Find" class="ellipsis">Pod::Find</a></li>
  <li><a href="./Pod::ParseUtils.html" title="Pod::ParseUtils" class="ellipsis">Pod::ParseUtils</a></li>
  <li><a href="./Pod::Parser.html" title="Pod::Parser" class="ellipsis">Pod::Parser</a></li>
  <li><a href="./Pod::Select.html" title="Pod::Select" class="ellipsis">Pod::Select</a></li>
  <li><a href="https://metacpan.org/pod/if" title="if" class="ellipsis">if</a></li>
  <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/Pod::LaTeX/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=Pod%3A%3ALaTeX">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=Pod-LaTeX">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/TJENNESS/Pod-LaTeX-0.61/view/lib/Pod/LaTeX.pm">This version</a>
    </li>
    <li>
      <a href="./Pod::LaTeX.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/DELON"><img src="https://www.gravatar.com/avatar/8a316157de5eaa39f351b1725c4641d0?d=identicon&amp;s=20" title="DELON" alt="DELON"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/Pod-LaTeX/plussers">1 PAUSE user</a>
</div>
</div>
    </li>
    <li>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/TJENNESS" class="author-name">Tim Jenness</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/Pod/LaTeX.pm&#39;" class="">
<option
  selected
  value="TJENNESS/Pod-LaTeX-0.61"
>0.61
  (TJENNESS on 2013-01-18)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.60"
>0.60
  (TJENNESS on 2011-11-23)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.59"
>0.59
  (TJENNESS on 2011-01-04)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.58"
>0.58
  (TJENNESS on 2004-12-30)</option>
<optgroup label="BackPAN">'
<option
  
  value="TJENNESS/Pod-LaTeX-0.57"
>0.57
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.56"
>0.56
  (TJENNESS on 2004-03-08)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.55"
>0.55
  (TJENNESS on 2003-04-05)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.54"
>0.54
  (TJENNESS on 2001-11-20)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.53"
>0.53
  (TJENNESS on 2000-09-22)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.52"
>0.52
  (TJENNESS on 2000-05-16)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.51"
>0.51
  (TJENNESS on 2000-05-09)</option>
<option
  
  value="TJENNESS/Pod-LaTeX-0.50"
>0.50
  (TJENNESS on 2000-03-31)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/Pod-LaTeX">Pod-LaTeX-0.61</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage one &#10;
          • 2 direct dependents &#10;          • 2 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="10"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="Pod-LaTeX-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="Pod-LaTeX-0.61">
    <input type="hidden" name="author" value="TJENNESS">
    <input type="hidden" name="distribution" value="Pod-LaTeX">
    <button type="submit" class="favorite highlight"><span>1</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./Pod::LaTeX.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>1</span> ++</a>
</div>
   / <span>Pod::LaTeX</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./Pod::LaTeX.html#NAME">NAME</a></li>
  <li><a href="./Pod::LaTeX.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./Pod::LaTeX.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./Pod::LaTeX.html#OBJECT-METHODS">OBJECT METHODS</a>
    <ul>
      <li><a href="./Pod::LaTeX.html#Data-Accessors">Data Accessors</a></li>
    </ul>
  </li>
  <li><a href="./Pod::LaTeX.html#NOTES">NOTES</a></li>
  <li><a href="./Pod::LaTeX.html#SEE-ALSO">SEE ALSO</a></li>
  <li><a href="./Pod::LaTeX.html#AUTHORS">AUTHORS</a></li>
  <li><a href="./Pod::LaTeX.html#COPYRIGHT">COPYRIGHT</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>Pod::LaTeX - Convert Pod data to formatted Latex</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>  use Pod::LaTeX;
  my $parser = Pod::LaTeX-&gt;new ( );

  $parser-&gt;parse_from_filehandle;

  $parser-&gt;parse_from_file (&#39;file.pod&#39;, &#39;file.tex&#39;);</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p><code>Pod::LaTeX</code> is a module to convert documentation in the Pod format into Latex. The <a href="https://metacpan.org/pod/distribution/Pod-LaTeX/pod2latex.PL"><b>pod2latex</b></a>  command uses this module for translation.</p>

<p><code>Pod::LaTeX</code> is a derived class from <a href="./Pod::Select.html">Pod::Select</a>.</p>

<h1 id="OBJECT-METHODS"><a id="OBJECT"></a>OBJECT METHODS</h1>

<p>The following methods are provided in this module. Methods inherited from <code>Pod::Select</code> are not described in the public interface.</p>

<ul>

</ul>

<h2 id="Data-Accessors"><a id="Data"></a>Data Accessors</h2>

<p>The following methods are provided for accessing instance data. These methods should be used for accessing configuration parameters rather than assuming the object is a hash.</p>

<p>Default values can be supplied by using these names as keys to a hash of arguments when using the <code>new()</code> constructor.</p>

<dl>

<dt id="AddPreamble"><b>AddPreamble</b></dt>
<dd>

<p>Logical to control whether a <code>latex</code> preamble is to be written. If true, a valid <code>latex</code> preamble is written before the pod data is written. This is similar to:</p>

<pre><code>  \documentclass{article}
  \usepackage[T1]{fontenc}
  \usepackage{textcomp}
  \begin{document}</code></pre>

<p>but will be more complicated if table of contents and indexing are required. Can be used to set or retrieve the current value.</p>

<pre><code>  $add = $parser-&gt;AddPreamble();
  $parser-&gt;AddPreamble(1);</code></pre>

<p>If used in conjunction with <code>AddPostamble</code> a full latex document will be written that could be immediately processed by <code>latex</code>.</p>

<p>For some pod escapes it may be necessary to include the amsmath package. This is not yet added to the preamble automatically.</p>

</dd>
<dt id="AddPostamble"><b>AddPostamble</b></dt>
<dd>

<p>Logical to control whether a standard <code>latex</code> ending is written to the output file after the document has been processed. In its simplest form this is simply:</p>

<pre><code>  \end{document}</code></pre>

<p>but can be more complicated if a index is required. Can be used to set or retrieve the current value.</p>

<pre><code>  $add = $parser-&gt;AddPostamble();
  $parser-&gt;AddPostamble(1);</code></pre>

<p>If used in conjunction with <code>AddPreaamble</code> a full latex document will be written that could be immediately processed by <code>latex</code>.</p>

</dd>
<dt id="Head1Level"><b>Head1Level</b></dt>
<dd>

<p>The <code>latex</code> sectioning level that should be used to correspond to a pod <code>=head1</code> directive. This can be used, for example, to turn a <code>=head1</code> into a <code>latex</code> <code>subsection</code>. This should hold a number corresponding to the required position in an array containing the following elements:</p>

<pre><code> [0] chapter
 [1] section
 [2] subsection
 [3] subsubsection
 [4] paragraph
 [5] subparagraph</code></pre>

<p>Can be used to set or retrieve the current value:</p>

<pre><code>  $parser-&gt;Head1Level(2);
  $sect = $parser-&gt;Head1Level;</code></pre>

<p>Setting this number too high can result in sections that may not be reproducible in the expected way. For example, setting this to 4 would imply that <code>=head3</code> do not have a corresponding <code>latex</code> section (<code>=head1</code> would correspond to a <code>paragraph</code>).</p>

<p>A check is made to ensure that the supplied value is an integer in the range 0 to 5.</p>

<p>Default is for a value of 1 (i.e. a <code>section</code>).</p>

</dd>
<dt id="Label"><b>Label</b></dt>
<dd>

<p>This is the label that is prefixed to all <code>latex</code> label and index entries to make them unique. In general, pods have similarly titled sections (NAME, DESCRIPTION etc) and a <code>latex</code> label will be multiply defined if more than one pod document is to be included in a single <code>latex</code> file. To overcome this, this label is prefixed to a label whenever a label is required (joined with an underscore) or to an index entry (joined by an exclamation mark which is the normal index separator). For example, <code>\label{text}</code> becomes <code>\label{Label_text}</code>.</p>

<p>Can be used to set or retrieve the current value:</p>

<pre><code>  $label = $parser-&gt;Label;
  $parser-&gt;Label($label);</code></pre>

<p>This label is only used if <code>UniqueLabels</code> is true. Its value is set automatically from the <code>NAME</code> field if <code>ReplaceNAMEwithSection</code> is true. If this is not the case it must be set manually before starting the parse.</p>

<p>Default value is <code>undef</code>.</p>

</dd>
<dt id="LevelNoNum"><b>LevelNoNum</b></dt>
<dd>

<p>Control the point at which <code>latex</code> section numbering is turned off. For example, this can be used to make sure that <code>latex</code> sections are numbered but subsections are not.</p>

<p>Can be used to set or retrieve the current value:</p>

<pre><code>  $lev = $parser-&gt;LevelNoNum;
  $parser-&gt;LevelNoNum(2);</code></pre>

<p>The argument must be an integer between 0 and 5 and is the same as the number described in <code>Head1Level</code> method description. The number has nothing to do with the pod heading number, only the <code>latex</code> sectioning.</p>

<p>Default is 2. (i.e. <code>latex</code> subsections are written as <code>subsection*</code> but sections are numbered).</p>

</dd>
<dt id="MakeIndex"><b>MakeIndex</b></dt>
<dd>

<p>Controls whether <code>latex</code> commands for creating an index are to be inserted into the preamble and postamble</p>

<pre><code>  $makeindex = $parser-&gt;MakeIndex;
  $parser-&gt;MakeIndex(0);</code></pre>

<p>Irrelevant if both <code>AddPreamble</code> and <code>AddPostamble</code> are false (or equivalently, <code>UserPreamble</code> and <code>UserPostamble</code> are set).</p>

<p>Default is for an index to be created.</p>

</dd>
<dt id="ReplaceNAMEwithSection"><b>ReplaceNAMEwithSection</b></dt>
<dd>

<p>This controls whether the <code>NAME</code> section in the pod is to be translated literally or converted to a slightly modified output where the section name is the pod name rather than &quot;NAME&quot;.</p>

<p>If true, the pod segment</p>

<pre><code>  =head1 NAME

  pod::name - purpose

  =head1 SYNOPSIS</code></pre>

<p>is converted to the <code>latex</code></p>

<pre><code>  \section{pod::name\label{pod_name}\index{pod::name}}

  Purpose

  \subsection*{SYNOPSIS\label{pod_name_SYNOPSIS}%
               \index{pod::name!SYNOPSIS}}</code></pre>

<p>(dependent on the value of <code>Head1Level</code> and <code>LevelNoNum</code>). Note that subsequent <code>head1</code> directives translate to subsections rather than sections and that the labels and index now include the pod name (dependent on the value of <code>UniqueLabels</code>).</p>

<p>The <code>Label</code> is set from the pod name regardless of any current value of <code>Label</code>.</p>

<pre><code>  $mod = $parser-&gt;ReplaceNAMEwithSection;
  $parser-&gt;ReplaceNAMEwithSection(0);</code></pre>

<p>Default is to translate the pod literally.</p>

</dd>
<dt id="StartWithNewPage"><b>StartWithNewPage</b></dt>
<dd>

<p>If true, each pod translation will begin with a <code>latex</code> <code>\clearpage</code>.</p>

<pre><code>  $parser-&gt;StartWithNewPage(1);
  $newpage = $parser-&gt;StartWithNewPage;</code></pre>

<p>Default is false.</p>

</dd>
<dt id="TableOfContents"><b>TableOfContents</b></dt>
<dd>

<p>If true, a table of contents will be created. Irrelevant if <code>AddPreamble</code> is false or <code>UserPreamble</code> is set.</p>

<pre><code>  $toc = $parser-&gt;TableOfContents;
  $parser-&gt;TableOfContents(1);</code></pre>

<p>Default is false.</p>

</dd>
<dt id="UniqueLabels"><b>UniqueLabels</b></dt>
<dd>

<p>If true, the translator will attempt to make sure that each <code>latex</code> label or index entry will be uniquely identified by prefixing the contents of <code>Label</code>. This allows multiple documents to be combined without clashing common labels such as <code>DESCRIPTION</code> and <code>SYNOPSIS</code></p>

<pre><code>  $parser-&gt;UniqueLabels(1);
  $unq = $parser-&gt;UniqueLabels;</code></pre>

<p>Default is true.</p>

</dd>
<dt id="UserPreamble"><b>UserPreamble</b></dt>
<dd>

<p>User supplied <code>latex</code> preamble. Added before the pod translation data.</p>

<p>If set, the contents will be prepended to the output file before the translated data regardless of the value of <code>AddPreamble</code>. <code>MakeIndex</code> and <code>TableOfContents</code> will also be ignored.</p>

</dd>
<dt id="UserPostamble"><b>UserPostamble</b></dt>
<dd>

<p>User supplied <code>latex</code> postamble. Added after the pod translation data.</p>

<p>If set, the contents will be prepended to the output file after the translated data regardless of the value of <code>AddPostamble</code>. <code>MakeIndex</code> will also be ignored.</p>

</dd>
</dl>

<h1 id="NOTES">NOTES</h1>

<p>Compatible with <code>latex2e</code> only. Can not be used with <code>latex</code> v2.09 or earlier.</p>

<p>A subclass of <code>Pod::Select</code> so that specific pod sections can be converted to <code>latex</code> by using the <code>select</code> method.</p>

<p>Some HTML escapes are missing and many have not been tested.</p>

<h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1>

<p><a href="./Pod::Parser.html">Pod::Parser</a>, <a href="./Pod::Select.html">Pod::Select</a>, <a href="https://metacpan.org/pod/distribution/Pod-LaTeX/pod2latex.PL">pod2latex</a>, <a href="https://metacpan.org/pod/Pod::Simple">Pod::Simple</a>.</p>

<h1 id="AUTHORS">AUTHORS</h1>

<p>Tim Jenness &lt;tjenness@cpan.org&gt;</p>

<p>Bug fixes and improvements have been received from: Simon Cozens &lt;simon@cozens.net&gt;, Mark A. Hershberger &lt;mah@everybody.org&gt;, Marcel Grunauer &lt;marcel@codewerk.com&gt;, Hugh S Myers &lt;hsmyers@sdragons.com&gt;, Peter J Acklam &lt;jacklam@math.uio.no&gt;, Sudhi Herle &lt;sudhi@herle.net&gt;, Ariel Scolnicov &lt;ariels@compugen.co.il&gt;, Adriano Rodrigues Ferreira &lt;ferreira@triang.com.br&gt;, R. de Vries &lt;r.de.vries@dutchspace.nl&gt; and Dave Mitchell &lt;davem@iabyn.com&gt;.</p>

<h1 id="COPYRIGHT">COPYRIGHT</h1>

<p>Copyright (C) 2011 Tim Jenness. Copyright (C) 2000-2004 Tim Jenness. All Rights Reserved.</p>

<p>This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install Pod::LaTeX, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm Pod::LaTeX</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install Pod::LaTeX</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./Pod::LaTeX.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
